<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>eccodes: eccodes::codes_grib_find_nearest Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">eccodes
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>C&#160;Interface</span></a></li>
      <li><a href="classeccodes.html"><span>F90&#160;Interface</span></a></li>
      <li><a href="namespaces.html"><span>Python&#160;Interface</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="classeccodes.html">eccodes</a></li><li class="navelem"><a class="el" href="interfaceeccodes_1_1codes__grib__find__nearest.html">codes_grib_find_nearest</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">eccodes::codes_grib_find_nearest Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Find the nearest point/points of a given latitude/longitude point.  
 <a href="interfaceeccodes_1_1codes__grib__find__nearest.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a96fb4afe88914ad24ac796fbecc453c4"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__grib__find__nearest.html#a96fb4afe88914ad24ac796fbecc453c4">codes_grib_find_nearest_single</a> (gribid, is_lsm, inlat, inlon, outlat, outlon, value, distance, kindex, status)</td></tr>
<tr class="memdesc:a96fb4afe88914ad24ac796fbecc453c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the nearest point of a given latitude/longitude point.  <a href="#a96fb4afe88914ad24ac796fbecc453c4">More...</a><br/></td></tr>
<tr class="separator:a96fb4afe88914ad24ac796fbecc453c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b677451802af47da342addf6624870a"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__grib__find__nearest.html#a2b677451802af47da342addf6624870a">codes_grib_find_nearest_four_single</a> (gribid, is_lsm, inlat, inlon, outlat, outlon, value, distance, kindex, status)</td></tr>
<tr class="memdesc:a2b677451802af47da342addf6624870a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the 4 nearest points of a latitude longitude point.  <a href="#a2b677451802af47da342addf6624870a">More...</a><br/></td></tr>
<tr class="separator:a2b677451802af47da342addf6624870a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb92b7a78966c0b2f53ee6e288bff673"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceeccodes_1_1codes__grib__find__nearest.html#acb92b7a78966c0b2f53ee6e288bff673">codes_grib_find_nearest_multiple</a> (gribid, is_lsm, inlats, inlons, outlats, outlons, values, distances, indexes, status)</td></tr>
<tr class="memdesc:acb92b7a78966c0b2f53ee6e288bff673"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the nearest point of a set of points whose latitudes and longitudes are given in the inlats, inlons arrays respectively.  <a href="#acb92b7a78966c0b2f53ee6e288bff673">More...</a><br/></td></tr>
<tr class="separator:acb92b7a78966c0b2f53ee6e288bff673"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Find the nearest point/points of a given latitude/longitude point. </p>
<p>The value in the nearest point (or the four nearest points) is returned as well as the zero based index (which can be used in <a class="el" href="interfaceeccodes_1_1codes__get__element.html">codes_get_element</a>) and its distance from the given point using the following formula radius * acos( sin(lat1)*sin(lat2)+cos(lat1)*cos(lat2)*cos(lon1-lon2) ).</p>
<p>If the is_lsm flag is .true. the input field gribid is considered as a land sea mask and the nearest land point is returned.<br/>
 The nearest land point among the four neighbours is:</p>
<ul>
<li>the nearest point with land sea mask value &gt;= 0.5</li>
<li>the nearest without any other condition if all the four have land sea mask value &lt;0.5.</li>
</ul>
<p>Arrays (real(8)) of latitude/longitude can be provided to find with one call the values,indexes and distances for all the lat/lon points listed in the arrays.</p>
<p>If a single latitude/longitude point is provided and outlat,outlon,value,distance,index are defined as arrays with four elements the lat/lon coordinates and values, distances and indexes of the four nearest points are returned.</p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
 Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<p><b>Examples:</b> <a href="https://software.ecmwf.int/wiki/display/ECC/grib_nearest" target="_blank">grib_nearest.f90</a></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">is_lsm</td><td>.true. if the nearest land point is required otherwise .false. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">inlat</td><td>latitude of the point in degrees </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">inlon</td><td>longitudes of the point in degrees </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">outlat</td><td>latitude of the nearest point in degrees </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">outlon</td><td>longitude of the nearest point in degrees </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">distance</td><td>distance between the given point and its nearest (in km) </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">index</td><td>zero based index </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>value of the field in the nearest point </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
  </table>
  </dd>
</dl>
</div><h2 class="groupheader">Member Function/Subroutine Documentation</h2>
<a class="anchor" id="a2b677451802af47da342addf6624870a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">subroutine codes_grib_find_nearest_four_single </td>
          <td>(</td>
          <td class="paramtype">integer(kind=kindofint), intent(in)&#160;</td>
          <td class="paramname"><em>gribid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">logical, intent(in)&#160;</td>
          <td class="paramname"><em>is_lsm</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), intent(in)&#160;</td>
          <td class="paramname"><em>inlat</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), intent(in)&#160;</td>
          <td class="paramname"><em>inlon</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), dimension(4), intent(out)&#160;</td>
          <td class="paramname"><em>outlat</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), dimension(4), intent(out)&#160;</td>
          <td class="paramname"><em>outlon</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), dimension(4), intent(out)&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), dimension(4), intent(out)&#160;</td>
          <td class="paramname"><em>distance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">integer(kind = kindofint), dimension(4), intent(out)&#160;</td>
          <td class="paramname"><em>kindex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">integer(kind=kindofint), intent(out), optional&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Find the 4 nearest points of a latitude longitude point. </p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
 Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">gribid</td><td>id of the GRIB loaded in memory </td></tr>
    <tr><td class="paramname">is_lsm</td><td>.true. if the nearest land point is required otherwise .false. </td></tr>
    <tr><td class="paramname">inlat</td><td>latitude of the point </td></tr>
    <tr><td class="paramname">inlon</td><td>longitudes of the point </td></tr>
    <tr><td class="paramname">outlat</td><td>latitude of the nearest point </td></tr>
    <tr><td class="paramname">outlon</td><td>longitude of the nearest point </td></tr>
    <tr><td class="paramname">distance</td><td>distance between the given point and its nearest </td></tr>
    <tr><td class="paramname">kindex</td><td>zero based index </td></tr>
    <tr><td class="paramname">value</td><td>value of the field in the nearest point </td></tr>
    <tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="acb92b7a78966c0b2f53ee6e288bff673"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">subroutine codes_grib_find_nearest_multiple </td>
          <td>(</td>
          <td class="paramtype">integer(kind=kindofint), intent(in)&#160;</td>
          <td class="paramname"><em>gribid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">logical, intent(in)&#160;</td>
          <td class="paramname"><em>is_lsm</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), dimension(:), intent(in)&#160;</td>
          <td class="paramname"><em>inlats</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), dimension(:), intent(in)&#160;</td>
          <td class="paramname"><em>inlons</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), dimension(:), intent(out)&#160;</td>
          <td class="paramname"><em>outlats</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), dimension(:), intent(out)&#160;</td>
          <td class="paramname"><em>outlons</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), dimension(:), intent(out)&#160;</td>
          <td class="paramname"><em>values</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), dimension(:), intent(out)&#160;</td>
          <td class="paramname"><em>distances</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">integer(kind = kindofint), dimension(:), intent(out)&#160;</td>
          <td class="paramname"><em>indexes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">integer(kind=kindofint), intent(out), optional&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Find the nearest point of a set of points whose latitudes and longitudes are given in the inlats, inlons arrays respectively. </p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
 Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr>
    <tr><td class="paramname">is_lsm</td><td>.true. if the nearest land point is required otherwise .false. </td></tr>
    <tr><td class="paramname">inlats</td><td>input real(8) array of the latitudes of the points </td></tr>
    <tr><td class="paramname">inlons</td><td>input real(8) array of the longitudes of the points </td></tr>
    <tr><td class="paramname">outlats</td><td>output real(8) array of the latitudes of the nearest points </td></tr>
    <tr><td class="paramname">outlons</td><td>output real(8) array of the longitudes of the nearest points </td></tr>
    <tr><td class="paramname">distances</td><td>output real(8) array of the distances </td></tr>
    <tr><td class="paramname">indexes</td><td>output integer(4) array of the zero based indexes </td></tr>
    <tr><td class="paramname">values</td><td>output real(8) array of the values </td></tr>
    <tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a96fb4afe88914ad24ac796fbecc453c4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">subroutine codes_grib_find_nearest_single </td>
          <td>(</td>
          <td class="paramtype">integer(kind=kindofint), intent(in)&#160;</td>
          <td class="paramname"><em>gribid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">logical, intent(in)&#160;</td>
          <td class="paramname"><em>is_lsm</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), intent(in)&#160;</td>
          <td class="paramname"><em>inlat</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), intent(in)&#160;</td>
          <td class="paramname"><em>inlon</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), intent(out)&#160;</td>
          <td class="paramname"><em>outlat</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), intent(out)&#160;</td>
          <td class="paramname"><em>outlon</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), intent(out)&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">real(kind = kindofdouble), intent(out)&#160;</td>
          <td class="paramname"><em>distance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">integer(kind = kindofint), intent(out)&#160;</td>
          <td class="paramname"><em>kindex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">integer(kind=kindofint), intent(out), optional&#160;</td>
          <td class="paramname"><em>status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Find the nearest point of a given latitude/longitude point. </p>
<p>In case of error, if the status parameter (optional) is not given, the program will exit with an error message.<br/>
 Otherwise the error message can be gathered with <a class="el" href="classeccodes.html#a835de867b8ad79cc43f127e7048712f3">codes_get_error_string</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">gribid</td><td>id of the grib loaded in memory </td></tr>
    <tr><td class="paramname">is_lsm</td><td>.true. if the nearest land point is required otherwise .false. </td></tr>
    <tr><td class="paramname">inlat</td><td>latitude of the point </td></tr>
    <tr><td class="paramname">inlon</td><td>longitudes of the point </td></tr>
    <tr><td class="paramname">outlat</td><td>latitude of the nearest point </td></tr>
    <tr><td class="paramname">outlon</td><td>longitude of the nearest point </td></tr>
    <tr><td class="paramname">distance</td><td>distance between the given point and its nearest </td></tr>
    <tr><td class="paramname">kindex</td><td>zero based index </td></tr>
    <tr><td class="paramname">value</td><td>value of the field in the nearest point </td></tr>
    <tr><td class="paramname">status</td><td>CODES_SUCCESS if OK, integer value on error </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>eccodes_f90.f90</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
